Skip to content

Commit e5e5b3f

Browse files
Claudehotlong
Claude
and
hotlong
authored
Standardize metadata types to singular form across Studio frontend
Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/4b4cd0a2-3590-43af-8b11-0e6b59c0e99a Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 1a71c72 commit e5e5b3f

8 files changed

Lines changed: 74 additions & 84 deletions

File tree

‎apps/studio/src/components/app-sidebar.tsx‎

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -72,34 +72,31 @@ import {
7272
// ─── Icon & label hints ──────────────────────────────────────────────
7373
const META_TYPE_HINTS: Record<string, { label: string; icon: LucideIcon }> = {
7474
object: { label: 'Objects', icon: Package },
75-
objects: { label: 'Objects', icon: Package },
76-
hooks: { label: 'Hooks', icon: Anchor },
77-
mappings: { label: 'Mappings', icon: Map },
78-
analyticsCubes: { label: 'Analytics Cubes', icon: PieChart },
75+
hook: { label: 'Hooks', icon: Anchor },
76+
mapping: { label: 'Mappings', icon: Map },
77+
analyticsCube: { label: 'Analytics Cubes', icon: PieChart },
7978
data: { label: 'Seed Data', icon: Database },
8079
app: { label: 'Apps', icon: AppWindow },
81-
apps: { label: 'Apps', icon: AppWindow },
82-
actions: { label: 'Actions', icon: Zap },
83-
views: { label: 'Views', icon: Eye },
84-
pages: { label: 'Pages', icon: FileCode },
85-
dashboards: { label: 'Dashboards', icon: BarChart3 },
86-
reports: { label: 'Reports', icon: FileText },
87-
themes: { label: 'Themes', icon: Palette },
88-
flows: { label: 'Flows', icon: Workflow },
89-
workflows: { label: 'Workflows', icon: Workflow },
90-
approvals: { label: 'Approvals', icon: CheckSquare },
91-
webhooks: { label: 'Webhooks', icon: Webhook },
92-
roles: { label: 'Roles', icon: UserCog },
93-
permissions: { label: 'Permissions', icon: Lock },
94-
profiles: { label: 'Profiles', icon: Shield },
95-
sharingRules: { label: 'Sharing Rules', icon: Shield },
96-
policies: { label: 'Policies', icon: Shield },
97-
agents: { label: 'Agents', icon: Bot },
98-
ragPipelines: { label: 'RAG Pipelines', icon: BookOpen },
99-
apis: { label: 'APIs', icon: Globe },
100-
connectors: { label: 'Connectors', icon: Link2 },
80+
action: { label: 'Actions', icon: Zap },
81+
view: { label: 'Views', icon: Eye },
82+
page: { label: 'Pages', icon: FileCode },
83+
dashboard: { label: 'Dashboards', icon: BarChart3 },
84+
report: { label: 'Reports', icon: FileText },
85+
theme: { label: 'Themes', icon: Palette },
86+
flow: { label: 'Flows', icon: Workflow },
87+
workflow: { label: 'Workflows', icon: Workflow },
88+
approval: { label: 'Approvals', icon: CheckSquare },
89+
webhook: { label: 'Webhooks', icon: Webhook },
90+
role: { label: 'Roles', icon: UserCog },
91+
permission: { label: 'Permissions', icon: Lock },
92+
profile: { label: 'Profiles', icon: Shield },
93+
sharingRule: { label: 'Sharing Rules', icon: Shield },
94+
policy: { label: 'Policies', icon: Shield },
95+
agent: { label: 'Agents', icon: Bot },
96+
ragPipeline: { label: 'RAG Pipelines', icon: BookOpen },
97+
api: { label: 'APIs', icon: Globe },
98+
connector: { label: 'Connectors', icon: Link2 },
10199
plugin: { label: 'Plugins', icon: Layers },
102-
plugins: { label: 'Plugins', icon: Layers },
103100
kind: { label: 'Kinds', icon: Database },
104101
};
105102

‎apps/studio/src/plugins/built-in/ai-plugin.tsx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ export const aiProtocolPlugin: StudioPlugin = {
2323
key: 'ai',
2424
label: 'AI',
2525
icon: 'bot',
26-
metadataTypes: ['agents', 'ragPipelines'],
26+
metadataTypes: ['agent', 'ragPipeline'],
2727
order: 50,
2828
},
2929
],
3030
metadataIcons: [
31-
{ metadataType: 'agents', label: 'Agents', icon: 'bot' },
32-
{ metadataType: 'ragPipelines', label: 'RAG Pipelines', icon: 'book-open' },
31+
{ metadataType: 'agent', label: 'Agents', icon: 'bot' },
32+
{ metadataType: 'ragPipeline', label: 'RAG Pipelines', icon: 'book-open' },
3333
],
3434
},
3535
}),
3636

3737
activate(api) {
38-
api.registerMetadataIcon('agents', Bot, 'Agents');
39-
api.registerMetadataIcon('ragPipelines', BookOpen, 'RAG Pipelines');
38+
api.registerMetadataIcon('agent', Bot, 'Agents');
39+
api.registerMetadataIcon('ragPipeline', BookOpen, 'RAG Pipelines');
4040
},
4141
};

‎apps/studio/src/plugins/built-in/api-plugin.tsx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ export const apiProtocolPlugin: StudioPlugin = {
2323
key: 'api',
2424
label: 'API',
2525
icon: 'globe',
26-
metadataTypes: ['apis', 'connectors'],
26+
metadataTypes: ['api', 'connector'],
2727
order: 60,
2828
},
2929
],
3030
metadataIcons: [
31-
{ metadataType: 'apis', label: 'APIs', icon: 'globe' },
32-
{ metadataType: 'connectors', label: 'Connectors', icon: 'link-2' },
31+
{ metadataType: 'api', label: 'APIs', icon: 'globe' },
32+
{ metadataType: 'connector', label: 'Connectors', icon: 'link-2' },
3333
],
3434
},
3535
}),
3636

3737
activate(api) {
38-
api.registerMetadataIcon('apis', Globe, 'APIs');
39-
api.registerMetadataIcon('connectors', Link2, 'Connectors');
38+
api.registerMetadataIcon('api', Globe, 'APIs');
39+
api.registerMetadataIcon('connector', Link2, 'Connectors');
4040
},
4141
};

‎apps/studio/src/plugins/built-in/automation-plugin.tsx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ export const automationProtocolPlugin: StudioPlugin = {
2323
key: 'automation',
2424
label: 'Automation',
2525
icon: 'workflow',
26-
metadataTypes: ['flows', 'workflows', 'approvals', 'webhooks'],
26+
metadataTypes: ['flow', 'workflow', 'approval', 'webhook'],
2727
order: 30,
2828
},
2929
],
3030
metadataIcons: [
31-
{ metadataType: 'flows', label: 'Flows', icon: 'workflow' },
32-
{ metadataType: 'workflows', label: 'Workflows', icon: 'workflow' },
33-
{ metadataType: 'approvals', label: 'Approvals', icon: 'check-square' },
34-
{ metadataType: 'webhooks', label: 'Webhooks', icon: 'webhook' },
31+
{ metadataType: 'flow', label: 'Flows', icon: 'workflow' },
32+
{ metadataType: 'workflow', label: 'Workflows', icon: 'workflow' },
33+
{ metadataType: 'approval', label: 'Approvals', icon: 'check-square' },
34+
{ metadataType: 'webhook', label: 'Webhooks', icon: 'webhook' },
3535
],
3636
},
3737
}),
3838

3939
activate(api) {
40-
api.registerMetadataIcon('flows', Workflow, 'Flows');
41-
api.registerMetadataIcon('workflows', Workflow, 'Workflows');
42-
api.registerMetadataIcon('approvals', CheckSquare, 'Approvals');
43-
api.registerMetadataIcon('webhooks', Webhook, 'Webhooks');
40+
api.registerMetadataIcon('flow', Workflow, 'Flows');
41+
api.registerMetadataIcon('workflow', Workflow, 'Workflows');
42+
api.registerMetadataIcon('approval', CheckSquare, 'Approvals');
43+
api.registerMetadataIcon('webhook', Webhook, 'Webhooks');
4444
},
4545
};

‎apps/studio/src/plugins/built-in/default-plugin.tsx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,13 @@ import type { StudioPlugin, MetadataViewerProps } from '../types';
2020

2121
// ─── Helpers ─────────────────────────────────────────────────────────
2222

23-
/** Map Studio metadataType (often plural) to CodeExporter's ExportType (singular). */
23+
/** Map Studio metadataType to CodeExporter's ExportType (all now use singular). */
2424
const METADATA_TO_EXPORT_TYPE: Record<string, CodeExporterProps['type']> = {
2525
object: 'object',
26-
objects: 'object',
2726
view: 'view',
28-
views: 'view',
2927
flow: 'flow',
30-
flows: 'flow',
3128
agent: 'agent',
32-
agents: 'agent',
3329
app: 'app',
34-
apps: 'app',
3530
};
3631

3732
// ─── Preview Viewer (JSON Inspector) ─────────────────────────────────

‎apps/studio/src/plugins/built-in/object-plugin.tsx‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export const objectDesignerPlugin: StudioPlugin = {
3232
metadataViewers: [
3333
{
3434
id: 'object-explorer',
35-
metadataTypes: ['object', 'objects'],
35+
metadataTypes: ['object'],
3636
label: 'Object Explorer',
3737
priority: 100,
3838
modes: ['preview', 'data', 'code'],
@@ -43,16 +43,15 @@ export const objectDesignerPlugin: StudioPlugin = {
4343
key: 'data',
4444
label: 'Data',
4545
icon: 'database',
46-
metadataTypes: ['object', 'objects', 'hooks', 'mappings', 'analyticsCubes', 'data'],
46+
metadataTypes: ['object', 'hook', 'mapping', 'analyticsCube', 'data'],
4747
order: 10,
4848
},
4949
],
5050
metadataIcons: [
5151
{ metadataType: 'object', label: 'Objects', icon: 'package' },
52-
{ metadataType: 'objects', label: 'Objects', icon: 'package' },
53-
{ metadataType: 'hooks', label: 'Hooks', icon: 'anchor' },
54-
{ metadataType: 'mappings', label: 'Mappings', icon: 'map' },
55-
{ metadataType: 'analyticsCubes', label: 'Analytics Cubes', icon: 'pie-chart' },
52+
{ metadataType: 'hook', label: 'Hooks', icon: 'anchor' },
53+
{ metadataType: 'mapping', label: 'Mappings', icon: 'map' },
54+
{ metadataType: 'analyticsCube', label: 'Analytics Cubes', icon: 'pie-chart' },
5655
{ metadataType: 'data', label: 'Seed Data', icon: 'database' },
5756
],
5857
},
@@ -64,10 +63,9 @@ export const objectDesignerPlugin: StudioPlugin = {
6463

6564
// Register Lucide icons for metadata types
6665
api.registerMetadataIcon('object', Package, 'Objects');
67-
api.registerMetadataIcon('objects', Package, 'Objects');
68-
api.registerMetadataIcon('hooks', Anchor, 'Hooks');
69-
api.registerMetadataIcon('mappings', Map, 'Mappings');
70-
api.registerMetadataIcon('analyticsCubes', PieChart, 'Analytics Cubes');
66+
api.registerMetadataIcon('hook', Anchor, 'Hooks');
67+
api.registerMetadataIcon('mapping', Map, 'Mappings');
68+
api.registerMetadataIcon('analyticsCube', PieChart, 'Analytics Cubes');
7169
api.registerMetadataIcon('data', Database, 'Seed Data');
7270
},
7371
};

‎apps/studio/src/plugins/built-in/security-plugin.tsx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ export const securityProtocolPlugin: StudioPlugin = {
2323
key: 'security',
2424
label: 'Security',
2525
icon: 'shield',
26-
metadataTypes: ['roles', 'permissions', 'profiles', 'sharingRules', 'policies'],
26+
metadataTypes: ['role', 'permission', 'profile', 'sharingRule', 'policy'],
2727
order: 40,
2828
},
2929
],
3030
metadataIcons: [
31-
{ metadataType: 'roles', label: 'Roles', icon: 'user-cog' },
32-
{ metadataType: 'permissions', label: 'Permissions', icon: 'lock' },
33-
{ metadataType: 'profiles', label: 'Profiles', icon: 'shield' },
34-
{ metadataType: 'sharingRules', label: 'Sharing Rules', icon: 'shield' },
35-
{ metadataType: 'policies', label: 'Policies', icon: 'shield' },
31+
{ metadataType: 'role', label: 'Roles', icon: 'user-cog' },
32+
{ metadataType: 'permission', label: 'Permissions', icon: 'lock' },
33+
{ metadataType: 'profile', label: 'Profiles', icon: 'shield' },
34+
{ metadataType: 'sharingRule', label: 'Sharing Rules', icon: 'shield' },
35+
{ metadataType: 'policy', label: 'Policies', icon: 'shield' },
3636
],
3737
},
3838
}),
3939

4040
activate(api) {
41-
api.registerMetadataIcon('roles', UserCog, 'Roles');
42-
api.registerMetadataIcon('permissions', Lock, 'Permissions');
43-
api.registerMetadataIcon('profiles', Shield, 'Profiles');
44-
api.registerMetadataIcon('sharingRules', Shield, 'Sharing Rules');
45-
api.registerMetadataIcon('policies', Shield, 'Policies');
41+
api.registerMetadataIcon('role', UserCog, 'Roles');
42+
api.registerMetadataIcon('permission', Lock, 'Permissions');
43+
api.registerMetadataIcon('profile', Shield, 'Profiles');
44+
api.registerMetadataIcon('sharingRule', Shield, 'Sharing Rules');
45+
api.registerMetadataIcon('policy', Shield, 'Policies');
4646
},
4747
};

‎apps/studio/src/plugins/built-in/ui-plugin.tsx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,27 @@ export const uiProtocolPlugin: StudioPlugin = {
2525
key: 'ui',
2626
label: 'UI',
2727
icon: 'app-window',
28-
metadataTypes: ['actions', 'views', 'pages', 'dashboards', 'reports', 'themes'],
28+
metadataTypes: ['action', 'view', 'page', 'dashboard', 'report', 'theme'],
2929
order: 20,
3030
},
3131
],
3232
metadataIcons: [
33-
{ metadataType: 'actions', label: 'Actions', icon: 'zap' },
34-
{ metadataType: 'views', label: 'Views', icon: 'eye' },
35-
{ metadataType: 'pages', label: 'Pages', icon: 'file-code' },
36-
{ metadataType: 'dashboards', label: 'Dashboards', icon: 'bar-chart-3' },
37-
{ metadataType: 'reports', label: 'Reports', icon: 'file-text' },
38-
{ metadataType: 'themes', label: 'Themes', icon: 'palette' },
33+
{ metadataType: 'action', label: 'Actions', icon: 'zap' },
34+
{ metadataType: 'view', label: 'Views', icon: 'eye' },
35+
{ metadataType: 'page', label: 'Pages', icon: 'file-code' },
36+
{ metadataType: 'dashboard', label: 'Dashboards', icon: 'bar-chart-3' },
37+
{ metadataType: 'report', label: 'Reports', icon: 'file-text' },
38+
{ metadataType: 'theme', label: 'Themes', icon: 'palette' },
3939
],
4040
},
4141
}),
4242

4343
activate(api) {
44-
api.registerMetadataIcon('actions', Zap, 'Actions');
45-
api.registerMetadataIcon('views', Eye, 'Views');
46-
api.registerMetadataIcon('pages', FileCode, 'Pages');
47-
api.registerMetadataIcon('dashboards', BarChart3, 'Dashboards');
48-
api.registerMetadataIcon('reports', FileText, 'Reports');
49-
api.registerMetadataIcon('themes', Palette, 'Themes');
44+
api.registerMetadataIcon('action', Zap, 'Actions');
45+
api.registerMetadataIcon('view', Eye, 'Views');
46+
api.registerMetadataIcon('page', FileCode, 'Pages');
47+
api.registerMetadataIcon('dashboard', BarChart3, 'Dashboards');
48+
api.registerMetadataIcon('report', FileText, 'Reports');
49+
api.registerMetadataIcon('theme', Palette, 'Themes');
5050
},
5151
};

0 commit comments

Comments
 (0)