Add ContentTypeManagement widget to ui.xml by jmendeza · Pull Request #3903 · craftercms/studio

jmendeza · 2026-03-19T18:35:01Z

Add ContentTypeManagement widget to ui.xml
craftercms/craftercms#8496
Related to
craftercms/craftercms#8583

Summary by CodeRabbit

New Features
- Adds a Content Type Management widget to the Studio UI for configuring page and component schemas, system properties, control icons and datasource mappings.
Chores
- Introduces automated upgrade steps to apply the UI transformation during version upgrades.
Tests
- Adds test coverage validating the UI upgrade/XSLT transformation.

coderabbitai · 2026-03-19T18:43:34Z

Walkthrough

Adds an XSLT upgrade that conditionally injects a new craftercms.components.ContentTypeManagement widget (with page and component descriptors) into siteUi, plus pipeline entries, repo bootstrap UI files, tests, and input/expected XML fixtures for the transformation.

Changes

Cohort / File(s)	Summary
XSLT transformation `src/main/resources/crafter/studio/upgrade/5.0.x/config/ui/ui-v5.0.0.1.xslt`	New XSLT 2.0 identity transform that appends a `craftercms.components.ContentTypeManagement` `<widget>` under `<siteUi>` only if it doesn't already exist; defines `page` and `component` object types, fields, sections, controls, and datasources.
Upgrade pipelines `src/main/resources/crafter/studio/upgrade/pipelines.yaml`	Added pipeline steps: a `pipelines.system.versions` step (5.0.0.15 → 5.0.0.16) updating sample UI, and a `configurations.ui.pipeline.versions` step (5.0.0.0 → 5.0.0.1) that runs the new XSLT upgrader.
Repo-bootstrap / UI config `src/main/webapp/repo-bootstrap/global/blueprints/1000_website_editorial/config/studio/ui.xml`, `src/main/webapp/repo-bootstrap/global/configuration/samples/sample-ui.xml`	Inserted `craftercms.components.ContentTypeManagement` widget declarations into repo-bootstrap and sample UI; includes object type schemas (`page`, `component`), field descriptors (`file-name`, `internal-name`, `navLabel`, `placeInNav`), and UI icon mappings for controls/datasources.
Tests & fixtures `src/test/java/org/craftercms/studio/XsltTest.java`, `src/test/resources/crafter/studio/upgrade/xslt/ui/v5.0/5.0.0.1/input.xml`, `.../expected.xml`	Added TestNG data provider and test method to validate XSLT. Included input fixture (baseline `siteUi`) and expected fixture (`siteUi` with injected ContentTypeManagement configuration).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

sumerjabri

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title 'Add ContentTypeManagement widget to ui.xml' accurately describes the primary change—adding a new widget to UI configuration files.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

🧹 Nitpick comments (2)

src/main/resources/crafter/studio/upgrade/pipelines.yaml (1)
1365-1367: Misleading commit message.

The commitDetails says "Update the UI to use new icons for dashboard widgets" but the actual change performed by ui-v5.0.0.1.xslt is injecting the craftercms.components.ContentTypeManagement widget. Consider updating to accurately describe the change, e.g., "Add ContentTypeManagement widget to ui.xml".
Suggested fix
             -   currentVersion: 5.0.0.0
                 nextVersion: 5.0.0.1
                 operations:
                     -   type: xsltFileUpgrader
                         template: crafter/studio/upgrade/5.0.x/config/ui/ui-v5.0.0.1.xslt
-                        commitDetails: Update the UI to use new icons for dashboard widgets
+                        commitDetails: Add ContentTypeManagement widget to ui.xml
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/main/resources/crafter/studio/upgrade/pipelines.yaml` around lines 1365 -
1367, The commitDetails for the xsltFileUpgrader entry referencing template
crafter/studio/upgrade/5.0.x/config/ui/ui-v5.0.0.1.xslt is misleading; change
the commitDetails string from "Update the UI to use new icons for dashboard
widgets" to an accurate description such as "Add ContentTypeManagement widget to
ui.xml" so it reflects that the XSLT injects the
craftercms.components.ContentTypeManagement widget.
src/main/webapp/repo-bootstrap/global/blueprints/1000_website_editorial/config/studio/ui.xml (1)
394-479: Add ContentTypeManagement widget definition to other blueprints for consistency.

The 2000_headless_store, 4000_empty, and 5000_headless_blog blueprints reference craftercms.components.ContentTypeManagement as a tool with only a self-closing widget tag, while 1000_website_editorial includes the full widget definition with configuration for objectTypes (page and component). Adding the widget definition to the other blueprints would align their configuration with 1000_website_editorial.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@src/main/webapp/repo-bootstrap/global/blueprints/1000_website_editorial/config/studio/ui.xml`
around lines 394 - 479, The other blueprints (2000_headless_store, 4000_empty,
5000_headless_blog) only include a self-closing <widget
id="craftercms.components.ContentTypeManagement" /> while 1000_website_editorial
defines the full widget with <configuration> containing <objectTypes id="page">
and <objectTypes id="component">; update those blueprints to replace the
self-closing widget with the full ContentTypeManagement widget definition copied
from 1000_website_editorial (including the page and component <descriptor>
entries, fields like file-name, internal-name, navLabel, placeInNav, and the
System Properties <sections>) so all blueprints share the same configured
craftercms.components.ContentTypeManagement widget.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/main/resources/crafter/studio/upgrade/pipelines.yaml`:
- Around line 1365-1367: The commitDetails for the xsltFileUpgrader entry
referencing template crafter/studio/upgrade/5.0.x/config/ui/ui-v5.0.0.1.xslt is
misleading; change the commitDetails string from "Update the UI to use new icons
for dashboard widgets" to an accurate description such as "Add
ContentTypeManagement widget to ui.xml" so it reflects that the XSLT injects the
craftercms.components.ContentTypeManagement widget.

In
`@src/main/webapp/repo-bootstrap/global/blueprints/1000_website_editorial/config/studio/ui.xml`:
- Around line 394-479: The other blueprints (2000_headless_store, 4000_empty,
5000_headless_blog) only include a self-closing <widget
id="craftercms.components.ContentTypeManagement" /> while 1000_website_editorial
defines the full widget with <configuration> containing <objectTypes id="page">
and <objectTypes id="component">; update those blueprints to replace the
self-closing widget with the full ContentTypeManagement widget definition copied
from 1000_website_editorial (including the page and component <descriptor>
entries, fields like file-name, internal-name, navLabel, placeInNav, and the
System Properties <sections>) so all blueprints share the same configured
craftercms.components.ContentTypeManagement widget.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4c373df2-5efd-48b6-a71e-0cb765884d68

📥 Commits

Reviewing files that changed from the base of the PR and between c233f16 and 40a3714.

📒 Files selected for processing (7)

src/main/resources/crafter/studio/upgrade/5.0.x/config/ui/ui-v5.0.0.1.xslt
src/main/resources/crafter/studio/upgrade/pipelines.yaml
src/main/webapp/repo-bootstrap/global/blueprints/1000_website_editorial/config/studio/ui.xml
src/main/webapp/repo-bootstrap/global/configuration/samples/sample-ui.xml
src/test/java/org/craftercms/studio/XsltTest.java
src/test/resources/crafter/studio/upgrade/xslt/ui/v5.0/5.0.0.1/expected.xml
src/test/resources/crafter/studio/upgrade/xslt/ui/v5.0/5.0.0.1/input.xml

jvega190 · 2026-04-20T20:24:39Z

All good here

russdanner

The one thing that stands out to me is the name of this tag is plural but it represents a signle objectType. I think this will lead to mistakes.

<objectTypes id="component">

You see the same patter with controls and data sources:

<controls id="input-email">

sumerjabri · 2026-05-05T14:51:27Z

@russdanner I'll hold off until you approve this PR.

russdanner · 2026-05-05T20:30:21Z

The one thing that stands out to me is the name of this tag is plural but it represents a signle objectType. I think this will lead to mistakes.
<objectTypes id="component">
You see the same patter with controls and data sources:
<controls id="input-email">

@rart @sumerjabri We need a decision on this

sumerjabri · 2026-05-07T20:00:09Z

@russdanner will changing this to singular break backward compat?

Add ContentTypeManagement widget to ui.xml

40a3714

coderabbitai Bot reviewed Mar 19, 2026

View reviewed changes

jmendeza added 2 commits April 20, 2026 13:19

Merge remote-tracking branch 'upstream/develop' into feature/8496

fdef8c5

Add controls and datasources to ui.xml updates

6938080

jmendeza mentioned this pull request Apr 20, 2026

Implement archetypes from configuration craftercms/craftercms#8496

Open

4 tasks

jmendeza marked this pull request as ready for review April 20, 2026 20:24

jmendeza requested a review from sumerjabri as a code owner April 20, 2026 20:24

russdanner reviewed Apr 21, 2026

View reviewed changes

russdanner mentioned this pull request May 4, 2026

Add Expired Date to the Content Type Editor Add Field's System types craftercms/craftercms#8416

Open

4 tasks

jvega190 mentioned this pull request May 4, 2026

Retrieve OOB controls/datasources from config file craftercms/craftercms#8583

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ContentTypeManagement widget to ui.xml#3903

Add ContentTypeManagement widget to ui.xml#3903
jmendeza wants to merge 3 commits intocraftercms:developfrom
jmendeza:feature/8496

jmendeza commented Mar 19, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Mar 19, 2026 •

edited

Loading

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

jvega190 commented Apr 20, 2026

Uh oh!

russdanner left a comment

Uh oh!

sumerjabri commented May 5, 2026

Uh oh!

russdanner commented May 5, 2026

Uh oh!

sumerjabri commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

jmendeza commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

jvega190 commented Apr 20, 2026

Uh oh!

russdanner left a comment

Choose a reason for hiding this comment

Uh oh!

sumerjabri commented May 5, 2026

Uh oh!

russdanner commented May 5, 2026

Uh oh!

sumerjabri commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jmendeza commented Mar 19, 2026 •

edited

Loading

coderabbitai Bot commented Mar 19, 2026 •

edited

Loading